#region Copyright Notice

// 
// 
//  
//  Copyright (c) 2009-2011 Anindya Chatterjee
//  
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//  
//      http://www.apache.org/licenses/LICENSE-2.0
//  
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// 
// 

#endregion

using System.Xml.Serialization;

namespace AbstractClass.LiveUpdate
{
    ///<summary>
    /// Defines methods for xml serialization of an object using <see cref="XObjectSerializer&lt;T&gt;"/>.
    ///</summary>    
    [XmlRoot]
    public interface IXObject
    {
        /// <summary>
        /// Gets or sets the default xml-namespace to be used for all the elements.
        /// </summary>
        /// <value>A string representing the default xml-namespace.</value>
        [XmlIgnore]
        string DefaultNamespace { get; set; }

        /// <summary>
        /// Gets or sets the <see cref="XmlSerializerNamespaces"/> for the object.
        /// </summary>
        /// <remarks>Mark this property in the implemented class using <see cref="XmlNamespaceDeclarationsAttribute"/>.</remarks>
        [XmlNamespaceDeclarations]
        XmlSerializerNamespaces XmlNamespaceCollection { get; set; }

        /// <summary>
        ///   Executes routines just after deserialization.
        /// </summary>
        void Init();

        /// <summary>
        ///   Executes routines just before serialization.
        /// </summary>
        void Close();
    }
}